Skip to content

Start adding documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 29, 2024
Merged

Start adding documentation #3

merged 12 commits into from
Jan 29, 2024

Conversation

seapagan
Copy link
Owner

@seapagan seapagan commented Jun 23, 2023

Convert the README to a MkDocs website, basic for this PR.

Also, in this PR, I'm changing the tooling/ linting to use Ruff instead of Flake8 et al, and fixing any linting issues

I will add an explanation and walkthrough the code in the next PR

Signed-off-by: Grant Ramsay <seapagan@gmail.com>
@seapagan seapagan added the documentation Improvements or additions to documentation label Jun 23, 2023
@seapagan seapagan self-assigned this Jun 23, 2023
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
@seapagan seapagan changed the title Staret adding documentation Start adding documentation Jan 29, 2024
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
@seapagan seapagan marked this pull request as ready for review January 29, 2024 14:49
@seapagan
Copy link
Owner Author

Merging now as there are code changes included to fix breaking issues

@seapagan seapagan merged commit efe7389 into main Jan 29, 2024
@seapagan seapagan deleted the add-docs branch January 29, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant